Add global.rt.speechmatics.com to Realtime endpoints docs#263
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| | All | US1 (USA) | us.rt.speechmatics.com | | ||
| | Customer type | Region | Endpoint | | ||
| | ------------- | ----------------------- | -------------------------- | | ||
| | All | Global (lowest-latency) | global.rt.speechmatics.com | |
There was a problem hiding this comment.
Region column label consistency. Every other row in this table follows a CODE (Place) pattern — EU1 (Europe), US1 (USA) — whereas Global (lowest-latency) puts a behaviour descriptor where the others put a location. The sentence directly below the table already explains the lowest-latency routing, so consider just Global in the Region column to keep the reference table structurally consistent.
(Ref: style guide, Reference — "Every entry must be structurally consistent with every other entry of the same type.")
| :::info | ||
| You can also connect to `wss://global.rt.speechmatics.com/v2/`, which automatically routes to the lowest-latency region. Customers with data residency requirements should use a regional endpoint (`eu.rt` / `us.rt`) instead. See [Supported endpoints](/get-started/authentication#supported-endpoints). | ||
| ::: |
There was a problem hiding this comment.
Three small consistency points on this note:
- Person — "Customers with data residency requirements should use…" is third person, while the matching warning on the authentication page uses second person ("If you have data residency or compliance requirements…"). The style guide defaults to "you"; worth matching.
- Hostnames — this abbreviates
eu.rt/us.rt, whereas the authentication page uses the fulleu.rt.speechmatics.com/us.rt.speechmatics.com. Suggest the full forms. - Duplication — the data-residency caveat now lives on both this page and the authentication page. Since this note already links to Supported endpoints, consider trimming it to the new fact (you can connect to the global endpoint) plus the link, and letting the authentication page be authoritative on the caveat.
(Refs: style guide #6 second person; terminology consistency; governance — link rather than duplicate.)
2 participants
What
Documents the new global real-time endpoint
global.rt.speechmatics.com(lowest-latency routing across regions, additive — the existingeu.rt/us.rtregional endpoints are unchanged).docs/get-started/authentication.mdx— adds aglobal.rt.speechmatics.comrow to the Realtime SaaS "Supported endpoints" table, a one-line description, and a:::warningdata-residency caveat (residency-sensitive customers should use a regional endpoint).docs/api-ref/realtime-transcription-websocket.mdx— adds a:::infonote that you can connect towss://global.rt.speechmatics.com/v2/, linking back to Supported endpoints.Validation
npm run buildpasses; the new#supported-endpointsanchor resolves.npm run spellcheckclean.